home *** CD-ROM | disk | FTP | other *** search
/ Workbench Design / WB Collection.iso / datatypes / binarydt / help / binary_dtc (.txt) next >
Amigaguide Document  |  1996-04-07  |  8KB  |  93 lines
  1. @database binary_dtc.doc
  2. @master doc/binary_dtc.doc
  3. @node main "binary_dtc.doc"
  4. @toc xref.library_xreffile@main
  5. @{settabs 40}@{" binary.datatype " link "binary.datatype"}    
  6. @endnode
  7. @node "binary.datatype" "binary.datatype/binary.datatype"
  8.     @{b}NAME@{ub}
  9.         binary.datatype -- data type for any binary file
  10.     @{b}FUNCTION@{ub}
  11.         The binary data type, a base-class of all binary data, is used to
  12.         load any binary file and displays the contents of the file in hex
  13.         format.
  14.     @{b}PREFS@{ub}
  15.         The data type tries to load the prefs file first from
  16.         "PROGDIR:Prefs/DataTypes/binary.prefs" and then
  17.         "ENV:DataTypes/binary.prefs" on each @{"OM_NEW" link "AG:SysInc/intuition/classusr.h/main" 63} method to set up the
  18.         attributes !
  19.         Up from version 39.10 it uses the @{"ReadArgs()" link "dos/ReadArgs()"} function to parse the
  20.         prefs file. The template is :
  21.         NOASCII/S,NOWRAP/S,NONE/S,@{"BYTE" link "AG:SysInc/exec/types.h/main" 43}/S,@{"WORD" link "AG:SysInc/exec/types.h/main" 39}/S,@{"LONG" link "AG:SysInc/exec/types.h/main" 36}/S,BPL=BYTESPERLINE/N/K
  22.         NOASCII   - sets @{"BDTA_ShowASCII" link "AG:OtherInc/datatypes/binaryclass.h/main" 85} to @{"FALSE" link "AG:SysInc/exec/types.h/main" 76}
  23.         NOWRAP    - sets @{"BDTA_DisplayWrap" link "AG:OtherInc/datatypes/binaryclass.h/main" 91} to @{"FALSE" link "AG:SysInc/exec/types.h/main" 76}
  24.         NONE      - sets @{"BDTA_DisplayHex" link "AG:OtherInc/datatypes/binaryclass.h/main" 80} to @{"BDTDH_NONE" link "AG:OtherInc/datatypes/binaryclass.h/main" 103}
  25.         @{"BYTE" link "AG:SysInc/exec/types.h/main" 43}      - sets @{"BDTA_DisplayHex" link "AG:OtherInc/datatypes/binaryclass.h/main" 80} to @{"BDTDH_BYTE" link "AG:OtherInc/datatypes/binaryclass.h/main" 104}
  26.         @{"WORD" link "AG:SysInc/exec/types.h/main" 39}      - sets @{"BDTA_DisplayHex" link "AG:OtherInc/datatypes/binaryclass.h/main" 80} to @{"BDTDH_WORD" link "AG:OtherInc/datatypes/binaryclass.h/main" 105}
  27.         @{"LONG" link "AG:SysInc/exec/types.h/main" 36}      - sets @{"BDTA_DisplayHex" link "AG:OtherInc/datatypes/binaryclass.h/main" 80} to @{"BDTDH_LONG" link "AG:OtherInc/datatypes/binaryclass.h/main" 106}
  28.         BYTESPERLINE <bpl> or
  29.         BPL <bpl> - sets @{"BDTA_BytesPerLine" link "AG:OtherInc/datatypes/binaryclass.h/main" 75} to <bpl> bytes
  30.         The options can be on several lines !
  31.     @{b}METHODS@{ub}
  32.         @{"OM_NEW" link "AG:SysInc/intuition/classusr.h/main" 63} -- Create a new text object from a binary file in hex mode.
  33.         @{"OM_DISPOSE" link "AG:SysInc/intuition/classusr.h/main" 64} -- dispose a object
  34.         @{"OM_GET" link "AG:SysInc/intuition/classusr.h/main" 66} -- get a attribute of the object
  35.         @{"OM_SET" link "AG:SysInc/intuition/classusr.h/main" 65} -- set attributes of the object
  36.         @{"OM_UPDATE" link "AG:SysInc/intuition/classusr.h/main" 70} -- update some attributes of the object
  37.         @{"GM_LAYOUT" link "AG:SysInc/intuition/gadgetclass.h/main" 199} -- Method to layout the hex text
  38.         @{"GM_RENDER" link "AG:SysInc/intuition/gadgetclass.h/main" 191} -- draw the object
  39.         @{"DTM_WRITE" link "AG:SysInc/datatypes/datatypesclass.h/main" 285} -- @{"DTWM_RAW" link "AG:SysInc/datatypes/datatypesclass.h/main" 429} mode is supported
  40.         @{"DTM_PRINT" link "AG:SysInc/datatypes/datatypesclass.h/main" 272} -- prints the hex text
  41.         @{"DTM_DRAW" link "AG:SysInc/datatypes/datatypesclass.h/main" 282} -- draws the datatype in the given @{"RastPort" link "AG:SysInc/graphics/rastport.h/main" 54} (This is
  42.             expermintal, I use this method for my new text.datatype to
  43.             embed other datatype objects ! Don't use this at the moment !)
  44.         @{"DTM_TRIGGER" link "AG:SysInc/datatypes/datatypesclass.h/main" 279} -- trigger methods to let the user input a search string
  45.             and to search next or previous occurence of that string :
  46.             @{"STM_ACTIVATE_FIELD" link "AG:SysInc/datatypes/datatypesclass.h/main" 373} (return) - opens the string requester. This
  47.                 requester is spawned asyncronly !
  48.             @{"STM_BROWSE_NEXT" link "AG:SysInc/datatypes/datatypesclass.h/main" 369} ('>') - searchs next occurence
  49.             @{"STM_BROWSE_PREV" link "AG:SysInc/datatypes/datatypesclass.h/main" 368} ('<') - searchs previous occurence
  50.         @{"DTBM_GETSTRING" link "AG:OtherInc/datatypes/binaryclass.h/main" 35} -- opens a requester to let the user input the
  51.             string !
  52.         @{"DTBM_SEARCHNEXT" link "AG:OtherInc/datatypes/binaryclass.h/main" 38} -- searchs for the next occurence of the specified
  53.             string
  54.         @{"DTBM_SEARCHPREV" link "AG:OtherInc/datatypes/binaryclass.h/main" 41} -- searchs for the previous occurance of the given
  55.             string
  56.     @{b}TAGS@{ub}
  57.         BDTA_Buffer -- (@{"UBYTE" link "AG:SysInc/exec/types.h/main" 47} *) pointer to the buffer, which should be
  58.             displayed.
  59.             Applicability is (ISG).
  60.         @{"BDTA_BufferLen" link "AG:OtherInc/datatypes/binaryclass.h/main" 70} -- (@{"ULONG" link "AG:SysInc/exec/types.h/main" 37}) length of the buffer supplied with
  61.             BDTA_Buffer tag. This must be given if the buffer tag is
  62.             specified.
  63.             Applicability is (ISG).
  64.         @{"BDTA_BytesPerLine" link "AG:OtherInc/datatypes/binaryclass.h/main" 75} -- (@{"UWORD" link "AG:SysInc/exec/types.h/main" 40}) number of bytes per line.
  65.             If @{"BDTA_DisplayHex" link "AG:OtherInc/datatypes/binaryclass.h/main" 80} is @{"BDTDH_WORD" link "AG:OtherInc/datatypes/binaryclass.h/main" 105} it must be a multiply of 2,
  66.             if it is @{"BDTDH_LONG" link "AG:OtherInc/datatypes/binaryclass.h/main" 106} it must be a multiply of 4 !
  67.             Default is 32.
  68.             Applicability is (ISGNU).
  69.         @{"BDTA_DisplayHex" link "AG:OtherInc/datatypes/binaryclass.h/main" 80} -- (@{"UWORD" link "AG:SysInc/exec/types.h/main" 40}) type of the display. The following types
  70.             are supported : @{"BDTDH_NONE" link "AG:OtherInc/datatypes/binaryclass.h/main" 103}  - displays no hex values
  71.                             @{"BDTDH_BYTE" link "AG:OtherInc/datatypes/binaryclass.h/main" 104}  - displays each byte in hex ( 8 bit)
  72.                             @{"BDTDH_WORD" link "AG:OtherInc/datatypes/binaryclass.h/main" 105}  - displays each word in hex (16 bit)
  73.                             @{"BDTDH_LONG" link "AG:OtherInc/datatypes/binaryclass.h/main" 106}  - displays each long in hex (32 bit)
  74.             Default is @{"BDTDH_LONG" link "AG:OtherInc/datatypes/binaryclass.h/main" 106}.
  75.             Applicability is (ISGNU).
  76.         @{"BDTA_ShowASCII" link "AG:OtherInc/datatypes/binaryclass.h/main" 85} -- (@{"BOOL" link "AG:SysInc/exec/types.h/main" 69}) display at the end of the line the
  77.             appropriate ASCII string !
  78.             Default is @{"TRUE" link "AG:SysInc/exec/types.h/main" 73}.
  79.             Applicability is (ISGNU).
  80.         @{"BDTA_DisplayWrap" link "AG:OtherInc/datatypes/binaryclass.h/main" 91} -- (@{"BOOL" link "AG:SysInc/exec/types.h/main" 69}) the @{"BDTA_BytesPerLine" link "AG:OtherInc/datatypes/binaryclass.h/main" 75} are ignored and the
  81.             byte number is retrieved from the object width !
  82.             Default is @{"TRUE" link "AG:SysInc/exec/types.h/main" 73}.
  83.             Applicability is (ISGNU).
  84.         @{"BDTA_Found" link "AG:OtherInc/datatypes/binaryclass.h/main" 97} -- (@{"STRPTR" link "AG:SysInc/exec/types.h/main" 52}) pointer to the buffer to highlight the line.
  85.             This is used to display the line of a found string !
  86.             Default is @{"NULL" link "AG:SysInc/exec/types.h/main" 79}
  87.             Applicability is (ISNU).
  88.     @{b}BUGS@{ub}
  89.         At the moment proportional fonts can't be handled.
  90.     @{b}SEE ALSO@{ub}
  91.         datatypesclass (where ?)
  92. @endnode
  93.